Version: 1.0.2

Get List of Card Holders

Get a list of card holders linked with a specified account.

Method: POST

{{URL}}/cardv2

Headers

Name	Value
Content-Type	application/json

Example

Payload Parameters

Parameters	Description
reference Optional	String Unique reference ID of the request Sample value: "visadps100003"
transactionType Mandatory	String Type of operation/transaction Constant value: "GET_CARDHOLDER_LIST"
customerId Mandatory	String Unique Id of the customer Sample value: "100000000006001"
accountNumber Mandatory	String Account number of the customer Sample value: "400320588344662"
product Mandatory	String Name of the product associated with the card Sample value: "DEFAULT"
channel Mandatory	Enum Processing channel through which the card transaction happens Valid values: PULSE VISA_DPS Sample value: "VISA_DPS"
program Mandatory	String Name of the program to which the card product is mapped Sample value: "DEFAULT"
pagination Optional	Object
offset Optional	Number Number of items to skip before starting to return the data Sample value: 1
max Optional	Number Maximum number of records to retrieve in this request Sample value: 10

Parameters

Description

reference

Optional

String

Unique reference ID of the request

Sample value: "visadps100003"

transactionType

Mandatory

String

Type of operation/transaction

Constant value: "GET_CARDHOLDER_LIST"

customerId

Mandatory

String

Unique Id of the customer

Sample value: "100000000006001"

accountNumber

Mandatory

String

Account number of the customer

Sample value: "400320588344662"

product

Mandatory

String

Name of the product associated with the card

Sample value: "DEFAULT"

channel

Mandatory

Enum

Processing channel through which the card transaction

happens

Valid values:

PULSE

VISA_DPS

Sample value: "VISA_DPS"

program

Mandatory

String

Name of the program to which the card product is mapped

Sample value: "DEFAULT"

pagination

Optional

Object

offset

Optional

Number

Number of items to skip before starting to return the data

Sample value: 1

max

Optional

Number

Maximum number of records to retrieve in this request

Sample value: 10

cURL
C#
Go
NodeJs

curl --location --globoff '{{URL}}/cardv2' \
--header 'Content-Type: application/json' \
--data '{"method":"ledger.CARD.request","id":"1","params":{"payload":{"reference":"visadps100003","transactionType":"GET_CARDHOLDER_LIST","customerId":"100000000006001","accountNumber":"400320588344662","product":"DEFAULT","channel":"VISA_DPS","program":"DEFAULT","pagination":{"offset":1,"max":10}},"api":{"signature":"{{signature}}","apiKey":"{{Api-key}}","credential":"{{cred}}"}}}'

var options = new RestClientOptions("{{URL}}/cardv2")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
var body = @"{
" + "\n" +
@"    ""method"": ""ledger.CARD.request"",
" + "\n" +
@"    ""id"": ""1"",
" + "\n" +
@"    ""params"": {
" + "\n" +
@"        ""payload"": {
" + "\n" +
@"            ""reference"": ""visadps100003"",
" + "\n" +
@"            ""transactionType"": ""GET_CARDHOLDER_LIST"",
" + "\n" +
@"            ""customerId"": ""100000000006001"",
" + "\n" +
@"            ""accountNumber"": ""400320588344662"",
" + "\n" +
@"            ""product"": ""DEFAULT"",
" + "\n" +
@"            ""channel"": ""VISA_DPS"",
" + "\n" +
@"            ""program"": ""DEFAULT"",
" + "\n" +
@"            ""pagination"": {
" + "\n" +
@"                ""offset"": 1,
" + "\n" +
@"                ""max"": 10
" + "\n" +
@"            }
" + "\n" +
@"        },
" + "\n" +
@"        ""api"": {
" + "\n" +
@"            ""signature"": ""{{signature}}"",
" + "\n" +
@"            ""apiKey"": ""{{Api-key}}"",
" + "\n" +
@"            ""credential"": ""{{cred}}""
" + "\n" +
@"        }
" + "\n" +
@"    }
" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "{{URL}}/cardv2"
  method := "POST"

  payload := strings.NewReader(`{`+"
"+`
    "method": "ledger.CARD.request",`+"
"+`
    "id": "1",`+"
"+`
    "params": {`+"
"+`
        "payload": {`+"
"+`
            "reference": "visadps100003",`+"
"+`
            "transactionType": "GET_CARDHOLDER_LIST",`+"
"+`
            "customerId": "100000000006001",`+"
"+`
            "accountNumber": "400320588344662",`+"
"+`
            "product": "DEFAULT",`+"
"+`
            "channel": "VISA_DPS",`+"
"+`
            "program": "DEFAULT",`+"
"+`
            "pagination": {`+"
"+`
                "offset": 1,`+"
"+`
                "max": 10`+"
"+`
            }`+"
"+`
        },`+"
"+`
        "api": {`+"
"+`
            "signature": "{{signature}}",`+"
"+`
            "apiKey": "{{Api-key}}",`+"
"+`
            "credential": "{{cred}}"`+"
"+`
        }`+"
"+`
    }`+"
"+`
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

var https = require('follow-redirects').https;
var fs = require('fs');

var options = {
  'method': 'POST',
  'hostname': '{{URL}}',
  'path': '/cardv2',
  'headers': {
    'Content-Type': 'application/json'
  },
  'maxRedirects': 20
};

var req = https.request(options, function (res) {
  var chunks = [];

  res.on("data", function (chunk) {
    chunks.push(chunk);
  });

  res.on("end", function (chunk) {
    var body = Buffer.concat(chunks);
    console.log(body.toString());
  });

  res.on("error", function (error) {
    console.error(error);
  });
});

var postData = JSON.stringify({
  "method": "ledger.CARD.request",
  "id": "1",
  "params": {
    "payload": {
      "reference": "visadps100003",
      "transactionType": "GET_CARDHOLDER_LIST",
      "customerId": "100000000006001",
      "accountNumber": "400320588344662",
      "product": "DEFAULT",
      "channel": "VISA_DPS",
      "program": "DEFAULT",
      "pagination": {
        "offset": 1,
        "max": 10
      }
    },
    "api": {
      "signature": "{{signature}}",
      "apiKey": "{{Api-key}}",
      "credential": "{{cred}}"
    }
  }
});

req.write(postData);

req.end();

Body

{
    "method": "ledger.CARD.request",
    "id": "1",
    "params": {
        "payload": {
            "reference": "visadps100003",
            "transactionType": "GET_CARDHOLDER_LIST",
            "customerId": "100000000006001",
            "accountNumber": "400320588344662",
            "product": "DEFAULT",
            "channel": "VISA_DPS",
            "program": "DEFAULT",
            "pagination": {
                "offset": 1,
                "max": 10
            }
        },
        "api": {
            "signature": "{{signature}}",
            "apiKey": "{{Api-key}}",
            "credential": "{{cred}}"
        }
    }
}

Response: 200

Response Parameters

Parameters	Description
id	String Response Id echoed from the request Id Sample value: " 1"
result	Object
cardHolders	Array
cardHolderId	String Unique id of the card holder Sample value: "CH00000000020002"
firstName	String First name of the account holder Sample value: "Matthew"
lastName	String Last name of the account holder Sample value: "Sandra"
phoneNumber	String Phone number of the account holder Sample value: "2562322420"
addressType	String Type of address Sample value: " NON_PRIMARY"
addressLine1	String First line of account holder's address Sample value: "3456W"
addressLine2	String Second line of account holder's address Sample value: "1st street"
city	String City where account holder resides Sample value: "Kansus"
state	String State where account holder resides Sample value: "KS"
zipCode	String Zipcode of account holder's address Sample value: "56213"
country	String Country where account holder resides Sample value: " US"
emailId	String Email address of the account holder Sample value: "mathewsandra+1@gmail.com"
createdDate	String Date and time when card holder was created Sample value: " 2024-11-20T06:46:50.442Z"
updatedDate	String Date and time when card holder details was updated Sample value: " 2024-11-20T06:46:50.442Z"
totalRecords	Number Total number of card holders Sample value: 4
api	Object
type	String Acknowledgement for type of operation requested for Constant value: " GET_CARDHOLDER_LIST_ACK"
reference	String Auto generated reference ID of this acknowledgment Sample value: " REFvisadps100003"
dateCreated	Number Unix timestamp of the response was created Sample value: 1732085581
originalReference	String Original reference ID taken from the request Sample value: " visadps100003"

{
  "id": "1",
  "result": {
    "cardHolders": [
      {
        "cardHolderId": "CH00000000018001",
        "firstName": "David",
        "lastName": "Test",
        "phoneNumber": "8456321509",
        "addressType": "PRIMARY",
        "addressLine1": "77 HOIT RD",
        "city": "EPSOM",
        "state": "AZ",
        "zipCode": "67002",
        "country": "US",
        "emailId": "abarna.rn+88@netxd.com",
        "createdDate": "2024-11-12T13:08:54.917Z",
        "updatedDate": "2024-11-12T13:08:54.917Z"
      },
      {
        "cardHolderId": "CH00000000019001",
        "firstName": "John",
        "lastName": "Deo",
        "phoneNumber": "2562322420",
        "addressType": "NON_PRIMARY",
        "addressLine1": "3456W",
        "addressLine2": "1st street",
        "city": "Kansus",
        "state": "KS",
        "zipCode": "56213",
        "country": "US",
        "emailId": "john.deo+1@gmail.com",
        "createdDate": "2024-11-13T06:45:40.388Z",
        "updatedDate": "2024-11-13T06:45:40.388Z"
      },
      {
        "cardHolderId": "CH00000000020002",
        "firstName": "Matthew",
        "lastName": "Sandra",
        "phoneNumber": "2562322420",
        "addressType": "NON_PRIMARY",
        "addressLine1": "3456W",
        "addressLine2": "1st street",
        "city": "Kansus",
        "state": "KS",
        "zipCode": "56213",
        "country": "US",
        "emailId": "mathewsandra+1@gmail.com",
        "createdDate": "2024-11-20T06:46:50.442Z",
        "updatedDate": "2024-11-20T06:46:50.442Z"
      },
      {
        "cardHolderId": "CH00000000020003",
        "firstName": "Matthew",
        "lastName": "Sandra",
        "phoneNumber": "2562322420",
        "addressType": "NON_PRIMARY",
        "addressLine1": "3456W",
        "addressLine2": "1st street",
        "city": "Kansus",
        "state": "KS",
        "zipCode": "56213",
        "country": "US",
        "emailId": "mathewsandra+1@gmail.com",
        "createdDate": "2024-11-20T06:51:22.476Z",
        "updatedDate": "2024-11-20T06:51:22.476Z"
      }
    ],
    "totalRecords": 4,
    "api": {
      "type": "GET_CARDHOLDER_LIST_ACK",
      "reference": "REFvisadps100003",
      "dateCreated": 1732085581,
      "originalReference": "visadps100003"
    }
  }
}

Get List of Card Holders

Method: POST​

Headers​

Example​

Body​

Response: 200​

Method: POST

Headers

Example

Body

Response: 200